#ifndef OMG_DDS_SUBSCRIPTION_HPP_
#define OMG_DDS_SUBSCRIPTION_HPP_

/* Copyright (c) 2009-2010, Real-Time Innovations, Inc.
 * Copyright (c) 2010, Object Management Group, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * - Redistributions of source code must retain the above copyright notice,
 *   this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright
 *   notice, this list of conditions and the following disclaimer in the
 *   documentation and/or other materials provided with the distribution.
 * - Neither the names of the above copyright holders nor the names of their
 *   contributors may be used to endorse or promote products derived from
 *   this software without specific prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL A COPYRIGHT HOLDER OR CONTRIBUTOR BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#include <tdds/sub/ReadCondition.hpp>
#include <tdds/sub/QueryCondition.hpp>
#include <dds/sub/DataReaderListener.hpp>
#include <dds/sub/SubscriberListener.hpp>
#include <dds/sub/Sample.hpp>
#include <tdds/sub/DataReader.hpp>
#include <tdds/sub/Subscriber.hpp>
#include <tdds/sub/CoherentAccess.hpp>


template <typename DELEGATE>
class tdds::sub::RequestedDeadlineMissedStatus : public dds::core::Value
{
    OMG_DDS_VALUE_TYPE(RequestedDeadlineMissedStatus)
    
public:
    int32_t total_count() const;
    int32_t total_count_change() const;
    const dds::core::InstanceHandle last_instance_handle() const;
    
private:
    friend class OMG_DDS_REQUESTED_DEADLINE_MISSED_STATUS_DELEGATE;
    DELEGATE impl_;
};


template <typename DELEGATE>
class tdds::sub::RequestedIncompatibleQosStatus : public dds::core::Value
{
    OMG_DDS_VALUE_TYPE(RequestedIncompatibleQosStatus)

public:
    int32_t total_count() const;

    int32_t total_count_change() const;

    dds::core::policy::QosPolicyId last_policy_id() const;

    dds::core::QosPolicyCountSeq policies() const;

    dds::core::QosPolicyCountSeq&
    policies(dds::core::QosPolicyCountSeq& dst) const;
    
private:
    friend class OMG_DDS_REQUESTED_INCOMPATIBLE_QOS_STATUS_DELEGATE;
    DELEGATE impl_;
};


template <typename DELEGATE>
class tdds::sub::SampleLostStatus : public dds::core::Value
{
    OMG_DDS_VALUE_TYPE(SampleLostStatus)
    
public:
    int32_t total_count() const;
    int32_t total_count_change() const;
    
private:
    friend class OMG_DDS_SAMPLE_LOST_STATUS_DELEGATE;
    DELEGATE impl_;
};


template <typename DELEGATE>
class tdds::sub::SampleRejectedStatus : public dds::core::Value
{
    OMG_DDS_VALUE_TYPE(SampleRejectedStatus)

public:
    enum Kind {
        NOT_REJECTED_KIND,
        REJECTED_BY_INSTANCES_LIMIT_KIND,
        REJECTED_BY_SAMPLES_LIMIT_KIND,
        REJECTED_BY_SAMPLES_PER_INSTANCE_LIMIT_KIND
    };
    
public:
    int32_t total_count() const;
    int32_t total_count_change() const;
    Kind last_reason() const;
    const dds::core::InstanceHandle last_instance_handle() const;
    
private:
    friend class OMG_DDS_SAMPLE_REJECTED_STATUS_DELEGATE;
    DELEGATE impl_;
};


template <typename DELEGATE>
class tdds::sub::LivelinessChangedStatus : public dds::core::Value
{
    OMG_DDS_VALUE_TYPE(LivelinessChangedStatus)
    
public:
    int32_t alive_count() const;
    int32_t not_alive_count() const;
    int32_t alive_count_change() const;
    int32_t not_alive_count_change() const;
    const dds::core::InstanceHandle last_publication_handle() const;
    
private:
    friend class OMG_DDS_LIVELINESS_CHANGED_STATUS_DELEGATE;
    DELEGATE impl_;
};


template <typename DELEGATE>
class tdds::sub::SubscriptionMatchedStatus : public dds::core::Value
{
    OMG_DDS_VALUE_TYPE(SubscriptionMatchedStatus)
    
public:
    int32_t total_count() const;
    int32_t total_count_change() const;
    int32_t current_count() const;
    int32_t current_count_change() const;
    const dds::core::InstanceHandle last_publication_handle() const;
    
private:
    friend class OMG_DDS_SUBSCRIPTION_MATCHED_STATUS_DELEGATE;
    DELEGATE impl_;
};


OMG_DDS_STATUS_TRAITS(dds::sub::RequestedDeadlineMissedStatus,  2);
OMG_DDS_STATUS_TRAITS(dds::sub::RequestedIncompatibleQosStatus, 6);
OMG_DDS_STATUS_TRAITS(dds::sub::SampleLostStatus,               7);
OMG_DDS_STATUS_TRAITS(dds::sub::SampleRejectedStatus,           8);
OMG_DDS_STATUS_TRAITS(dds::sub::LivelinessChangedStatus,        12);
OMG_DDS_STATUS_TRAITS(dds::sub::SubscriptionMatchedStatus,      14);


template <typename DELEGATE>
class tdds::sub::DataReaderQos : public dds::core::EntityQos
{
    OMG_DDS_VALUE_TYPE_NO_DEFAULT(DataReaderQos)

private:
    DataReaderQos();

public:
    DataReaderQos& operator=(const dds::topic::TopicQos& src);
    
public:
    const dds::core::policy::Durability&           durability() const;
    dds::core::policy::Durability&                 durability();

    const dds::core::policy::Deadline&             deadline() const;
    dds::core::policy::Deadline&                   deadline();

    const dds::core::policy::LatencyBudget&        latency_budget() const;
    dds::core::policy::LatencyBudget&              latency_budget();

    const dds::core::policy::Liveliness&           liveliness() const;
    dds::core::policy::Liveliness&                 liveliness();

    const dds::core::policy::Reliability&          reliability() const;
    dds::core::policy::Reliability&                reliability();

    const dds::core::policy::DestinationOrder&     destination_order() const;
    dds::core::policy::DestinationOrder&           destination_order();

    const dds::core::policy::History&              history() const;
    dds::core::policy::History&                    history();

    const dds::core::policy::ResourceLimits&       resource_limits() const;
    dds::core::policy::ResourceLimits&             resource_limits();

    const dds::core::policy::UserData&             user_data() const;
    dds::core::policy::UserData&                   user_data();

    const dds::core::policy::Ownership&            ownership() const;
    dds::core::policy::Ownership&                  ownership();

    const dds::core::policy::TimeBasedFilter&      time_based_filter() const;
    dds::core::policy::TimeBasedFilter&            time_based_filter();

    const dds::core::policy::ReaderDataLifecycle&  reader_data_lifecycle() const;
    dds::core::policy::ReaderDataLifecycle&        reader_data_lifecycle();

#ifdef OMG_DDS_EXTENSIBLE_AND_DYNAMIC_TOPIC_TYPE_SUPPORT
    const dds::core::policy::DataRepresentation& representation() const;
    void representation(const dds::core::policy::DataRepresentation& value);

    const dds::core::policy::TypeConsistencyEnforcement&
    type_consistency() const;

    void type_consistency(
        const dds::core::policy::TypeConsistencyEnforcement& value);
#endif  // defined(OMG_DDS_EXTENSIBLE_AND_DYNAMIC_TOPIC_TYPE_SUPPORT)

public:
    /**
     * Generic method for obtaining the value set for a specific policy
     * belonging to this QoS instance.
     */
    template <typename POLICY>
    const DataReaderQos& operator >>(POLICY& p) const;
    
    /**
     * Generic method for setting the value for a specific policy belonging
     * to this QoS instance.
     */
    template <typename POLICY>
    DataReaderQos& operator <<(const POLICY& p);
    
    // --- From EntityQos: --- //
public:
    virtual ConstQosPolicyMapType& policies() const;

    virtual QosPolicyMapType policies();

    // --- State: --- //
private:
    friend class OMG_DDS_DATA_READER_QOS_DELEGATE;
    DELEGATE impl_;
};


template <typename DELEGATE>
class tdds::sub::SubscriberQos : public dds::core::EntityQos
{
    OMG_DDS_VALUE_TYPE_NO_DEFAULT(SubscriberQos)

private:
    SubscriberQos();

public:
    const dds::core::policy::Presentation&     presentation() const;
    dds::core::policy::Presentation&           presentation();

    const dds::core::policy::Partition&        partition() const;
    dds::core::policy::Partition&              partition();

    const dds::core::policy::GroupData&        group_data() const;
    dds::core::policy::GroupData&              group_data();

    const dds::core::policy::EntityFactory&    entity_factory() const;
    dds::core::policy::EntityFactory&          entity_factory();

public:
    /**
     * Generic method for obtaining the value set for a specific policy
     * belonging to this QoS instance.
     */
    template <typename POLICY>
    const SubscriberQos& operator >>(POLICY& p) const;
    
    /**
     * Generic method for setting the value for a specific policy belonging
     * to this QoS instance.
     */
    template <typename POLICY>
    SubscriberQos& operator <<(const POLICY& p);
    
    // --- From EntityQos: --- //
public:
    virtual ConstQosPolicyMapType& policies() const;

    virtual QosPolicyMapType policies();

    // --- State: --- //    
private:
    friend class OMG_DDS_SUBSCRIBER_QOS_DELEGATE;
    DELEGATE impl_;
};


#endif // !defined(OMG_DDS_SUBSCRIPTION_HPP_)
